Administration API

The webservice is exposed in REST and is secured and client_id/client_secret enabled.

APPLICATION-RIGHTS

This operation gets the list of rights in check by it's technical id or an applicatiion id

REQUEST

url: /rest/v1/application-rights
URI parameters:
technicalId=Technical ID in Check
updSince=Last Update to retrieve changes
applicationIds=Application IDs list separated by comma

RESPONSE

{
  "header": {
    "apiName": "{name of the API}",
    "apiVersion": "{schema version following single digit format X}",
    "correlationId": "{correlationId conveyed all along the transaction}"
  },
  "data": [
    {
      "technicalId": Internal ID of the right,
      "rocPersonId": Person ID in the ROC ,
      "applicationRightsId": Right ID ??,
      "applicationId": Application ID in Check,
      "applicationRightsDesc": "Application Right Description",
      "applicationDesc": "Application Description",
      "organizationEntityType": Entity type of the right,
      "organizationEntityId": Entity ID of the right,
      "active": "Right active or not",
      "scopeId": Scope ID
    }
  ],
  "error": {}
}

JOB-ACTIVITY

This operation gets the list of Job activities in check by it's technical id or an applicatiion id

REQUEST

url: /rest/v1/job-activity
URI parameters:
jobActivityIds=JobActivity ID in Check list separated by comma
updSince=Last Update to retrieve changes

RESPONSE

{
  "header": {
    "apiName": "{name of the API}",
    "apiVersion": "{schema version following single digit format X}",
    "correlationId": "{correlationId conveyed all along the transaction}"
  },
  "data": [
    {
      "technicalId": technical ID of the job Activity,
      "rocPersonId": Person ID in the ROC,
      "jobActivityId": Job Activity ID,
      "jobFamilyId": Job Family ID,
      "mainJobActivity": "Is the main Job Activity or not",
      "active": "Is the JobActivity active",
      "startDate": "Job Activity start date",
      "endDate": "Job Activity End date"
    }
  ],
  "error": {}
}